/*
 * Copyright 2002-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.core.type.classreading;

import java.io.FileNotFoundException;
import java.io.IOException;

import org.springframework.core.io.DefaultResourceLoader;
import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;
import org.springframework.lang.Nullable;
import org.springframework.util.ClassUtils;

/**
 * Simple implementation of the {@link MetadataReaderFactory} interface,
 * creating a new ASM {@link org.springframework.asm.ClassReader} for every request.
 *
 * @author Juergen Hoeller
 * @since 2.5
 */

/**
 1. CachingMetadataReaderFactory 内部成员详解
 	CachingMetadataReaderFactory 是 MetadataReaderFactory 接口的缓存实现，为每个Spring Resource 句柄缓存 MetadataReader 实例：
 静态成员：
	 DEFAULT_CACHE_LIMIT: 默认本地 MetadataReader 缓存的最大条目数：256
 实例成员：
	 metadataReaderCache: Map<Resource, MetadataReader> 类型，MetadataReader 缓存：可能是本地缓存或在 ResourceLoader 级别的共享缓存
 构造方法：
	 CachingMetadataReaderFactory(): 使用本地资源缓存为默认类加载器创建新的 CachingMetadataReaderFactory
	 CachingMetadataReaderFactory(@Nullable ClassLoader classLoader): 使用本地资源缓存为给定的 ClassLoader 创建新的 CachingMetadataReaderFactory
	 CachingMetadataReaderFactory(@Nullable ResourceLoader resourceLoader): 为给定的 ResourceLoader 创建新的 CachingMetadataReaderFactory，如果支持则使用共享资源缓存，否则使用本地资源缓存
 核心方法：
	 void setCacheLimit(int cacheLimit): 指定 MetadataReader 缓存的最大条目数
	 int getCacheLimit(): 返回 MetadataReader 缓存的最大条目数
	 MetadataReader getMetadataReader(Resource resource) throws IOException: 重写父类方法，实现缓存逻辑
	 void clearCache(): 清除本地 MetadataReader 缓存
 内部类：
 	LocalResourceCache: 继承自 LinkedHashMap<Resource, MetadataReader> 的本地资源缓存实现
 2. 继承树和实现类
 继承关系：
 	CachingMetadataReaderFactory 继承自 SimpleMetadataReaderFactory
 实现接口：
	 MetadataReaderFactory：通过继承 SimpleMetadataReaderFactory 实现
	 没有子类：CachingMetadataReaderFactory 没有公开的子类
 3. 与其他类和接口的关系
	 与 MetadataReaderFactory：实现关系，是其缓存实现
	 与 SimpleMetadataReaderFactory：继承关系，扩展了其功能添加了缓存机制
	 与 MetadataReader：创建和缓存关系，负责创建并缓存 MetadataReader 实例
	 与 Resource：使用 Resource 作为缓存键
	 与 ResourceLoader：通过构造函数接收 ResourceLoader 并可能使用其共享缓存
	 与 DefaultResourceLoader：可以使用 DefaultResourceLoader 的共享资源缓存
 4. 总结
	 CachingMetadataReaderFactory 是Spring框架中 MetadataReaderFactory 的缓存实现，它通过缓存 MetadataReader 实例来提高性能。
	 该类继承自 SimpleMetadataReaderFactory，添加了缓存机制，可以使用本地缓存或 DefaultResourceLoader 的共享缓存。
	 默认缓存限制为256个条目，使用LRU(最近最少使用)策略淘汰旧条目。
 */
public class SimpleMetadataReaderFactory implements MetadataReaderFactory {

	private final ResourceLoader resourceLoader;


	/**
	 * Create a new SimpleMetadataReaderFactory for the default class loader.
	 */
	public SimpleMetadataReaderFactory() {
		this.resourceLoader = new DefaultResourceLoader();
	}

	/**
	 * Create a new SimpleMetadataReaderFactory for the given resource loader.
	 * @param resourceLoader the Spring ResourceLoader to use
	 * (also determines the ClassLoader to use)
	 */
	public SimpleMetadataReaderFactory(@Nullable ResourceLoader resourceLoader) {
		this.resourceLoader = (resourceLoader != null ? resourceLoader : new DefaultResourceLoader());
	}

	/**
	 * Create a new SimpleMetadataReaderFactory for the given class loader.
	 * @param classLoader the ClassLoader to use
	 */
	public SimpleMetadataReaderFactory(@Nullable ClassLoader classLoader) {
		this.resourceLoader =
				(classLoader != null ? new DefaultResourceLoader(classLoader) : new DefaultResourceLoader());
	}


	/**
	 * Return the ResourceLoader that this MetadataReaderFactory has been
	 * constructed with.
	 */
	public final ResourceLoader getResourceLoader() {
		return this.resourceLoader;
	}


	@Override
	public MetadataReader getMetadataReader(String className) throws IOException {
		try {
			String resourcePath = ResourceLoader.CLASSPATH_URL_PREFIX +
					ClassUtils.convertClassNameToResourcePath(className) + ClassUtils.CLASS_FILE_SUFFIX;
			Resource resource = this.resourceLoader.getResource(resourcePath);
			return getMetadataReader(resource);
		}
		catch (FileNotFoundException ex) {
			// Maybe an inner class name using the dot name syntax? Need to use the dollar syntax here...
			// ClassUtils.forName has an equivalent check for resolution into Class references later on.
			int lastDotIndex = className.lastIndexOf('.');
			if (lastDotIndex != -1) {
				String innerClassName =
						className.substring(0, lastDotIndex) + '$' + className.substring(lastDotIndex + 1);
				String innerClassResourcePath = ResourceLoader.CLASSPATH_URL_PREFIX +
						ClassUtils.convertClassNameToResourcePath(innerClassName) + ClassUtils.CLASS_FILE_SUFFIX;
				Resource innerClassResource = this.resourceLoader.getResource(innerClassResourcePath);
				if (innerClassResource.exists()) {
					return getMetadataReader(innerClassResource);
				}
			}
			throw ex;
		}
	}

	@Override
	public MetadataReader getMetadataReader(Resource resource) throws IOException {
		return new SimpleMetadataReader(resource, this.resourceLoader.getClassLoader());
	}

}
